home *** CD-ROM | disk | FTP | other *** search
/ Floppyshop 2 / Floppyshop - 2.zip / Floppyshop - 2.iso / diskmags / 5791-.end / dmg-6165 / stg-lite.txt < prev    next >
Text File  |  1995-09-02  |  9KB  |  240 lines
  1. ---------------------------------------------------------------------------
  2. README for ST-Guide Lite v1.4                                September 1995
  3. ===========================================================================
  4. Programmed by Holger Weets (c) 1994. For more details refer to the 
  5. ST-Guide HYPertext.
  6.  
  7. Distribution
  8. ------------
  9. ST-Guide Lite is a cut down version of the full ST-Guide hypertext system 
  10. and is ONLY for distribution with other applications which use ST-Guide 
  11. format documentation.
  12.  
  13. The files included in this archive or on the disk comprise the official 
  14. English version of ST-Guide Lite and may NOT under any circumstances be 
  15. distributed via BBSs, Mailboxes and PD libraries or included on Magazine 
  16. Cover disks, Magazine subscriber disks or CD-ROM collections without the 
  17. prior written permission of both Holger Weets and Joe Connor.
  18.  
  19. UK Support and registration
  20. ---------------------------
  21. ST-Guide is Fairware and supported in the UK by Joe Connor.
  22.  
  23. Benefits for registered users:
  24. - Access to the free update service
  25. - Labelled Master disk
  26. - ST-Guide illustrated on-line catalogue of supported software
  27. - ST-Guide on-line help
  28. - Selection of other software (dependent on disk space)
  29.  
  30. The Shareware/registration fees are set to cover the currency handling, 
  31. stationary, media and postage costs incurred in mailing out master disks. 
  32.  
  33. How to register inside the UK
  34. -----------------------------
  35. 2)  Make a cheque payable for at least £6 to Joe Connor.
  36. 3)  Be sure to include your name and address in a legible format!
  37. 4)  Send cheque to: 65 Mill Road, Colchester, CO4 5LJ, England
  38.  
  39. Joe Connor can be contacted by Email at: jconnor@cix.compulink.co.uk
  40.  
  41. ---------------------------------------------------------------------------
  42. Brief Installation guide (refer to the ST-Guide HYPertext for more info)
  43. ===========================================================================
  44. To minimise the risk of other software affecting the installation of 
  45. ST-Guide perform the installation after a reboot on a 'clean' minimum 
  46. system!
  47.  
  48. Extracting the archives (Skip if your version is already extracted)
  49. -------------------------------------------------------------------
  50. Extract the contents of the archives OR copy the contents of the 
  51. master disk onto the root directory of your boot partition/disk.
  52.  
  53. Either method should preserve the directory structure and ensures ST-GUIDE 
  54. can locate its files. Double check to ensure ST-GUIDE.ACC and ST-GUIDE.INF 
  55. reside in the root directory of the boot partition or disk.
  56.  
  57. Configuring ST-Guide Lite (Only neccessary if not pre-configured)
  58. -----------------------------------------------------------------
  59. Using a text editor (eg Everest) you can edit the example ST-GUIDE.INF 
  60. below and save it as ST-GUIDE.INF. Carefully read through the options. 
  61. Each option is described in detail followed by the option line itself. 
  62. Lines preceded with a '#' character are NOT currently active.
  63.  
  64. ST-GUIDE should not be renamed as some applications which offer on-line 
  65. help may not be able to find it.
  66.  
  67. Example ST-GUIDE.INF file:
  68.  
  69. ------------------------------ cut here ---------------------------------
  70. # ========================================================================
  71. # Please edit this ST-Guide INF file to your requirements
  72. # ========================================================================
  73. #
  74. # Read this!
  75. # This file can be edited in any ASCII text editor (eg Everest)
  76. # If you experience any problems with ST-Guide try removing 
  77. # ST-GUIDE.INF altogether. ST-Guide then uses its internal defaults.
  78. # If the problem goes away you'll know something is wrong with your 
  79. # ST-GUIDE.INF file.
  80. # This file is configured by default to run from Drive C: but anyone
  81. # running a floppy based system can simply change each occurence of 
  82. # C: to A:
  83. # By default ST-Guide looks in the root directory of your boot drive
  84. # for a 'GUIDES' folder which can be used to store all your 'HYP and 
  85. # 'REF' files.
  86. # Lines preceded with a '#' symbol (like this one) are comments and 
  87. # ignored by ST-Guide.
  88. #
  89. #
  90. # ST-Guide options:
  91. # -----------------
  92. # Default search path, where ST-Guide looks for 'HYP' hypertexts:
  93. PATHS=C:\GUIDES;A:\GUIDES
  94. #
  95. # Default directory ST-Guide opens when calling the File Selector.
  96. # The Hypertext ComPiler (HCP) also compiles to this path:
  97. HYPFOLD=C:\GUIDES\
  98. #
  99. # A list of file extenders and paths to external viewers may follow:
  100. C=
  101. IMG=C:\1STVIEW.ACC
  102. #
  103. # An external viewer, which must be memory resident can be used to 
  104. # display unknown file types:
  105. EXTVIEW=NOTICE
  106. #
  107. # The hypertext file to be loaded via the ST-Guide 'Catalog' option or 
  108. # when ST-Guide is started without parameters:
  109. HYPTOP=C:\GUIDES\CATALOG.HYP
  110. #
  111. # The file used to find references:
  112. REF=C:\GUIDES\ALL.REF
  113. #
  114. # ST-Guide can use GDOS screen fonts if loaded, the code determines the
  115. # font used. Refer to main documentation for syntax details:
  116. #FONT=98,9
  117. FONT=1,10
  118. #
  119. # The following three variables are only relevant in colour resolutions
  120. # and are ignored in monochrome resolutions.
  121. # TXTCOLOR Displays text in the specified colour.
  122. # REFCOLOR Displays references in the specified colour using the
  123. #          normal typestyle (NOT bold and underlined).
  124. # BCKCOLOR Background colour for ST-Guide windows.
  125. #
  126. # Default colours (Note! Your system may change these values!):
  127. #  0=White        1=Black        2=Red           3=Green
  128. #  4=Blue         5=Cyan         6=Yellow        7=Magenta
  129. #  8=Grey         9=Dark grey   10=Dark red     11=Dark green
  130. # 12=Dark blue   13=Dark cyan   14=Dark yellow  15=Dark magenta
  131. TXTCOLOR=2
  132. REFCOLOR=3
  133. #BCKCOLOR=8
  134. #
  135. # If this option is active (the value is irrelevant) a right mouse key 
  136. # click is interpreted as 'Retrace'.
  137. #RIGHTBACK=
  138. #
  139. # If this variable is active, clicking on 'normal' text does not cause
  140. # ST-Guide to search for references.
  141. #REFONLY=
  142. #
  143. # HCP is used to compile STG files into HYP files. STool uses this entry 
  144. # to find HCP and compile:
  145. HCP=C:\ST-GUIDE\HCP.TTP
  146. #
  147. # The number of spaces a tab will be expanded to is set here:
  148. #TABSIZE=4
  149. #
  150. # This variable is provided to install ARROWPATCH. This patch corrects a 
  151. # bug in the AES which prevents the scroll bars in windowed accessories
  152. # from working correctly with certain TOS versions.
  153. # If you exerience this behaviour activate this patch ON (by removing
  154. # the preceding #).
  155. # This patch is not needed if you are running WINX, MagiC, MTOS or 
  156. # already have the ARROWPATCH installed globally.
  157. #ARROWPATCH=1
  158. #
  159. # The first two values set the top left corner of the window. The
  160. # next two values set the bottom right corner for the ST-Guide window:
  161. #WINSIZE=100,100,400,200
  162. #
  163. # This file will be loaded automatically if ST-Guide is started without 
  164. # parameters:
  165. DEFHYP=ST-GUIDE.HYP
  166. #
  167. # These options are used automatically when HCP is called:
  168. #HCP_OPT=
  169. #
  170. # Hypfind is called by ST-Guide to search for search masks in all pages
  171. # in the current hypertext.
  172. HYPFIND=C:\ST-GUIDE\HYPFIND.TTP
  173. #
  174. # Whenever 'Print' is selected output is sent to the Clipboard and
  175. # Re-directed to this listed application for output:
  176. #PRINTER=C:\ILIST.ACC
  177. #
  178. # Path for Remarker:
  179. # Without '!' preceding the path Remarker is automatically started on
  180. # opening ST-Guide.
  181. # With '!' preceding the path Remarker is started using [Alternate]+R
  182. REMARKER=!C:\ST-GUIDE\REMARKER.PRG
  183. #
  184. # These options pass parameters from ST-Guide to HypTree:
  185. #HYPTREE_OPT=
  186. #
  187. # TO call STool from an ST-Guide hypertext:
  188. $STOOL=C:\ST-GUIDE\STOOL.TOS
  189. #
  190. #
  191. # RefCheck options:
  192. # -----------------
  193. # Path to RefLink for REFCHECK:
  194. REFLINK=C:\ST-GUIDE\REFLINK.TTP
  195. #
  196. # Default REFCHECK options used if no command line is passed:
  197. REFCHECK-OPT=ads
  198. #
  199. #
  200. # KATMAKER options:
  201. # -----------------
  202. # Output filenames in the hypertext without extenders
  203. KM_SHORT
  204. #
  205. # Display filenames in the hypertext in lower case characters
  206. KM_SMALL
  207. #
  208. #
  209. # HypTree options:
  210. # ----------------
  211. # Here the default size of the HypTree window can be displayed.
  212. # If these variables are not defined, the size and position of the last
  213. # window will be used, if available.
  214. HT_WINSIZE=40,40,100,200
  215. #
  216. # Using this switch you can decide whether all pages included in the 
  217. # HypTree structure are visible (0 = No, 1 = Yes)
  218. HT_OPENALL=1
  219. #
  220. # This variable sets the position of the triangle in the window
  221. # 0 = next to the text, 1 = On the left hand margin of the window.
  222. HT_MACLIKE=0
  223. #
  224. # The following command line is sent to HypTree from ST-Guide (via
  225. # VA_START) after the user double clicks on the menu bar title in any
  226. # hypertext page. The following strings are replaced with the actual 
  227. # values when called:
  228. # %p  Pathname of the hypertext file
  229. # %n  Name of the hypertext file (without path)
  230. # %s  The internal name of the hypertext page
  231. HT_CALLSTG=-s1 %p %s
  232. #
  233. # The following command line is sent to ST-Guide from HypTree as soon 
  234. # as the current hypertext is closed:
  235. HT_STOPSTG=-s0
  236. #
  237. # That's it!
  238. ------------------------------ cut here ---------------------------------
  239. EOF
  240.